Event Notification API

2.0.x
(0 reviews)

Event Notification APIs Examples

Event Notification APIs

Event Subscription Examples:

Post/event-subscriptions:

This API endpoint allows the TPP to ask an ASPSP to create a new event-subscription resource.

POST Event Subscription Request

POST /event-subscriptions HTTP/1.1

curl -X POST \
https://api.boi-sandbox.apiboitest.com/1/api/open-banking/v3.1/event-subscriptions \
-H ‘Authorization: Bearer 2YotnFZFEjr1zCsicMWpAA’\
-H ‘x-jws-signature: eyJodHRwOlwvXC9vcGVuYmFua2luZy5vcmcudWtcL2lhdCI6MTY0NzI0MjkwOCwiaHR0cDpcL1wvb3Blb
mJhbmtpbmcub3JnLnVrXC90YW4iOiJvcGVuYmFua2luZy5vcmcudWsiLCJjcml0IjpbImh0dHA6XC9cL2
9wZW5iYW5raW5nLm9yZy51a1wvaWF0IiwiaHR0cDpcL1wvb3BlbmJhbmtpbmcub3JnLnVrXC90YW4iLCJ
odHRwOlwvXC9vcGVuYmFua2luZy5vcmcudWtcL2lzcyJdLCJraWQiOiI2NVp3NnRVT0F1ejRDcTlLQTFy
cnFYd1VLN0EiLCJjdHkiOiJhcHBsaWNhdGlvblwvanNvbiIsInR5cCI6IkpPU0UiLCJodHRwOlwvXC9vc
GVuYmFua2luZy5vcmcudWtcL2lzcyI6IkNOPTAwMTU4MDAwMDBqZlE5YUFBRSwgT0lELjIuNS40Ljk3PV
BTREdCLUZDQS01MTI5NTYsIE89QmFuayBvZiBJcmVsYW5kIChVSykgUGxjLCBDPUdCIiwiYWxnIjoiUFM
yNTYifQ..qJIi8AGgtZuCpSZU-W8YTInfAIWrxSN5Ilf00jnzgi_NURn2wErjJR-crY0sz-f-
nLjWOBAbpvCbSskdxDu_9RM_z-097HrF9grYElSG-
RKfAqpGQ_yQseFYgtykE40yvFBGJItDTlMPjZtEyX0eBrrHphjWtY2OZ9
-HylSigy3tTTdIKO5VU5agwHjXccUAg_xPn7XYB-8a0vcrOP0ZacuHbdlmUh-fwJCyR7CDOb71W2B
-w5pyT0_QGF6PcjESELOlk0vPxf51fSU3r7efeH7Q5tqddv3DxskIn1yF9PxuYcU2uzX3N9IdQE43GwfY7
i5xmpM2rXG-zVnoqB8Hzg’\
-H ‘Content-Type: application/json;charset=utf-8
’ \

-d ‘{
  "Data": {
    "Version": "3.1"
  }
}’

POST Event Subscription Response

HTTP/1.1 201 Created

-H ‘x-jws-signature: eyJodHRwOlwvXC9vcGVuYmFua2luZy5vcmcudWtcL2lhdCI6MTY0NzI0MjkwOCwiaHR0cDpcL1wvb3Blb
mJhbmtpbmcub3JnLnVrXC90YW4iOiJvcGVuYmFua2luZy5vcmcudWsiLCJjcml0IjpbImh0dHA6XC9cL29w
ZW5iYW5raW5nLm9yZy51a1wvaWF0IiwiaHR0cDpcL1wvb3BlbmJhbmtpbmcub3JnLnVrXC90YW4iLCJodH
RwOlwvXC9vcGVuYmFua2luZy5vcmcudWtcL2lzcyJdLCJraWQiOiI2NVp3NnRVT0F1ejRDcTlLQTFycnFY
d1VLN0EiLCJjdHkiOiJhcHBsaWNhdGlvblwvanNvbiIsInR5cCI6IkpPU0UiLCJodHRwOlwvXC9vcGVuYm
Fua2luZy5vcmcudWtcL2lzcyI6IkNOPTAwMTU4MDAwMDBqZlE5YUFBRSwgT0lELjIuNS40Ljk3PVBTREdC
LUZDQS01MTI5NTYsIE89QmFuayBvZiBJcmVsYW5kIChVSykgUGxjLCBDPUdCIiwiYWxnIjoiUFMyNTYifQ
..qJIi8AGgtZuCpSZU-W8YTInfAIWrxSN5Ilf00jnzgi_NURn2wErjJR-crY0sz-f
-nLjWOBAbpvCbSskdxDu_9RM_z-097HrF9grYElSG-
RKfAqpGQ_yQseFYgtykE40yvFBGJItDTlMPjZtEyX0eBrrHphjWtY2OZ9
-HylSigy3tTTdIKO5VU5agwHjXccUAg_xPn7XYB-8a0vcrOP0ZacuHbdlmUh-fwJCyR7CDOb71W2B-
w5pyT0_QGF6PcjESELOlk0vPxf51fSU3r7efeH7Q5tqddv3DxskIn1yF9PxuYcU2uzX3N9IdQE43GwfY7i
5xmpM2rXG-zVnoqB8Hzg’\
-H ‘x-fapi-interaction-id: 86ebcd82-8e38-4f2d-a79c-965b41d15865’\
-H ‘Content-Type: application/json;charset=utf-8’\

-d ‘{
 "Data": {
        "EventSubscriptionId": "2319b838-4fbb-4978-9fc2-ea7e2dd7f45e",
        "Version": "3.1",
        "EventTypes": [
            "UK.OBIE.Consent-Authorization-Revoked"
        ]
    },
    "Links": {
        "Self": "https://api.boi-sandbox.apiboitest.com/1/api/open-banking/v3.1/event-subscriptions/2319b838-4fbb-4978-9fc2-ea7e2dd7f45e"
    },
    "Meta": {
        "TotalPages": 1
    }
}’
GET /event-subscriptions

The API endpoint allows the TPP to ask an ASPSP to retrieve its event-subscription resource. The ASPSP retrieves the event-subscription resource and responds with the resource.

GET Event Subscription Request
GET /event-subscriptions HTTP/1.1

curl -X POST \
https://api.boi-sandbox.apiboitest.com/1/api/open-banking/v3.1/event-subscriptions \
-H ‘Authorization: Bearer 2YotnFZFEjr1zCsicMWpAA’\
-H ‘Content-Type: application/json’\
-H ‘x-jws-signature: eyJodHRwOlwvXC9vcGVuYmFua2luZy5vcmcudWtcL2lhdCI6MTY0NzI0MjkwOCwiaHR0cDpcL1wvb3Bl
bmJhbmtpbmcub3JnLnVrXC90YW4iOiJvcGVuYmFua2luZy5vcmcudWsiLCJjcml0IjpbImh0dHA6XC9c
L29wZW5iYW5raW5nLm9yZy51a1wvaWF0IiwiaHR0cDpcL1wvb3BlbmJhbmtpbmcub3JnLnVrXC90YW4i
LCJodHRwOlwvXC9vcGVuYmFua2luZy5vcmcudWtcL2lzcyJdLCJraWQiOiI2NVp3NnRVT0F1ejRDcTlL
QTFycnFYd1VLN0EiLCJjdHkiOiJhcHBsaWNhdGlvblwvanNvbiIsInR5cCI6IkpPU0UiLCJodHRwOlwv
XC9vcGVuYmFua2luZy5vcmcudWtcL2lzcyI6IkNOPTAwMTU4MDAwMDBqZlE5YUFBRSwgT0lELjIuNS40
Ljk3PVBTREdCLUZDQS01MTI5NTYsIE89QmFuayBvZiBJcmVsYW5kIChVSykgUGxjLCBDPUdCIiwiYWxn
IjoiUFMyNTYifQ..qJIi8AGgtZuCpSZU-W8YTInfAIWrxSN5Ilf00jnzgi_NURn2wErjJR-crY0sz-f-
nLjWOBAbpvCbSskdxDu_9RM_z-097HrF9grYElSG-
RKfAqpGQ_yQseFYgtykE40yvFBGJItDTlMPjZtEyX0eBrrHphjWtY2OZ9-
HylSigy3tTTdIKO5VU5agwHjXccUAg_xPn7XYB-8a0vcrOP0ZacuHbdlmUh-fwJCyR7CDOb71W2B-
w5pyT0_QGF6PcjESELOlk0vPxf51fSU3r7efeH7Q5tqddv3DxskIn1yF9PxuYcU2uzX3N9IdQE43GwfY
7i5xmpM2rXG-zVnoqB8Hzg’\
GET Event Subscription Response
GET/1.1 200 OK

-H ‘x-jws-signature: eyJodHRwOlwvXC9vcGVuYmFua2luZy5vcmcudWtcL2lhdCI6MTY0NzI0MjkwOCwiaHR0cDpcL1wvb3Blb
mJhbmtpbmcub3JnLnVrXC90YW4iOiJvcGVuYmFua2luZy5vcmcudWsiLCJjcml0IjpbImh0dHA6XC9cL2
9wZW5iYW5raW5nLm9yZy51a1wvaWF0IiwiaHR0cDpcL1wvb3BlbmJhbmtpbmcub3JnLnVrXC90YW4iLCJ
odHRwOlwvXC9vcGVuYmFua2luZy5vcmcudWtcL2lzcyJdLCJraWQiOiI2NVp3NnRVT0F1ejRDcTlLQTFy
cnFYd1VLN0EiLCJjdHkiOiJhcHBsaWNhdGlvblwvanNvbiIsInR5cCI6IkpPU0UiLCJodHRwOlwvXC9vc
GVuYmFua2luZy5vcmcudWtcL2lzcyI6IkNOPTAwMTU4MDAwMDBqZlE5YUFBRSwgT0lELjIuNS40Ljk3PV
BTREdCLUZDQS01MTI5NTYsIE89QmFuayBvZiBJcmVsYW5kIChVSykgUGxjLCBDPUdCIiwiYWxnIjoiUFM
yNTYifQ..qJIi8AGgtZuCpSZU-W8YTInfAIWrxSN5Ilf00jnzgi_NURn2wErjJR-crY0sz-f-
nLjWOBAbpvCbSskdxDu_9RM_z-097HrF9grYElSG-
RKfAqpGQ_yQseFYgtykE40yvFBGJItDTlMPjZtEyX0eBrrHphjWtY2OZ9-
HylSigy3tTTdIKO5VU5agwHjXccUAg_xPn7XYB-8a0vcrOP0ZacuHbdlmUh-fwJCyR7CDOb71W2B-
w5pyT0_QGF6PcjESELOlk0vPxf51fSU3r7efeH7Q5tqddv3DxskIn1yF9PxuYcU2uzX3N9IdQE43GwfY7
i5xmpM2rXG-zVnoqB8Hzg’ \
-H ‘x-fapi-interaction-id: 86ebcd82-8e38-4f2d-a79c-965b41d15865’ \
-H ‘Content-Type: application/json’ \

-d ‘{

"Data": {
        "EventSubscription": [
            {
                "EventSubscriptionId": "2319b838-4fbb-4978-9fc2-ea7e2dd7f45e",
                "Version": "3.1",
                "EventTypes": [
                    "UK.OBIE.Consent-Authorization-Revoked"
                ]
            }
        ]
    },
    "Links": {
        "Self": "https://api.boi-sandbox.apiboitest.com/1/api/open-banking/v3.1/event-subscriptions"
    },
    "Meta": {
        "TotalPages": 1
    }
}’
DELETE /event-subscriptions/{EventSubscriptionId}

The API endpoint allows the TPP to ask an ASPSP to delete an event-subscription resource. The
ASPSP deletes the event-subscription resource.

DELETE Event Subscription Request
DELETE /event-subscriptions HTTP/1.1
curl -X POST \
https://api.boi-sandbox.apiboitest.com/1/api/open-banking/v3.1/event-subscriptions \
-H ‘Authorization: Bearer 2YotnFZFEjr1zCsicMWpAA’\
DELETE Event Subscription Response
DELETE/1.1 204 No Content
-H ‘Content-type: application/octet-stream; charset=UTF-8’ \
-H x-fapi-interaction-id: 495e23b3-2e69-4704-985b-7fd9738df2fd
Aggregated Polling Example:
POST /events

The endpoint allows a TPP to poll and acknowledge the events.

POST Events Request
POST /events HTTP/1.1

curl -X POST \
https://api.boi-sandbox.apiboitest.com/1/api/open-banking/v3.1/events \
-H ‘Authorization: Bearer 7b99f6c331e841dab811176e25d57ca7’\
-H ‘Content-Type: application/json;charset=utf-8’\

-d ‘{
  {
  "returnImmediately": true,
  "maxEvents": 12,
  "ack": [
    "2644f8cbc8294325ad103ddfc4a5b"
  ],
  "setErrs": {
    "1fd954d5fb964afb97deee232bb88d1f": {
      "err": "jwtIss",
      "description": "Issuer is invalid or could not be verified"
    }
  }
}
  }’
POST Events Response
POST /events HTTP/1.1

-H ‘Content-Type: application/json’\
-H ‘x-fapi-interaction-id: 3fc0df586e45404abd5bbf1b23ce343d’\
{
  "sets": {
    "25fd4432da4e4e609033a733aea68a54": "eyJhbG...8o8PLY"
    "54jt4432da4e4e609033a733aea73c29": "ghIhts...3o9UJO"
    "38dk4432da4e4e609033a733aea32h47": "leKjpW...6o8PFC"
  },
  "moreAvailable": false
}

Reviews